Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docker updates #3844

Closed
wants to merge 23 commits into from
Closed

Docker updates #3844

wants to merge 23 commits into from

Conversation

ghost
Copy link

@ghost ghost commented Mar 1, 2023 •
edited by ghost
Loading

This is a follow-on PR to #3839 and can be handled two ways; review this PR in place of #3839 or maintain commits of branched PR by not squash merging.

VIVO GitHub issue: #3822 and #3786

Also related to #3698 as the docker deployment supports specifying the Tomcat webapp context path.

What does this pull request do?

  • Improves docker image
    • not running tomcat as root
    • affords specifying webapp context path
    • supports loading sample data on reset of home
    • provides a subset of runtime properties to be defined on startup via environment variables
  • Affords substitution of context.xml variables
    • vitro/rootUserAddress
    • vitro/defaultNamespace

What's new?

Updates to the Dockerfile, docker-compose.yml, and start.sh script among other deployment related configuration files.

How should this be tested?

See README.md

Interested parties

@chenejac

@wwelling
Enable war deployment model (#197.1)
94a9351
@wwelling
Delay startup for Solr to start when using docker-compose
70da572
@wwelling
Docker improvements (WIP)
4c5ebb3
@wwelling
Update VIVO Dependencies GitHub branch reference
70d029c
@wwelling
Use app-name variable for log file naming
20e8799
@wwelling
Update README to build using package
687f27f
@wwelling
Merge branch 'VIVO-3034-psuedo-rebase' of https://github.com/vivo-pro…
3b11f1b 
…ject/VIVO into VIVO-3786-3822-docker-updates
@wwelling
Merge branch 'main' of https://github.com/vivo-project/VIVO into VIVO…
3017d81 
…-3034-psuedo-rebase
@wwelling
Merge branch 'VIVO-3034-psuedo-rebase' of https://github.com/vivo-pro…
31a3002 
…ject/VIVO into VIVO-3786-3822-docker-updates
@wwelling
Cleanup and README updates
f504b43
@wwelling
Environment variables added to java opts on start
70bc159
@wwelling
Afford reconfigure on restart
3b6cde3
@ghost ghost force-pushed the VIVO-3786-3822-docker-updates branch from 2f54b07 to 3b6cde3 Compare March 1, 2023 16:53
@ghost ghost mentioned this pull request Mar 2, 2023
Closed
@ghost ghost marked this pull request as ready for review March 3, 2023 15:33
@ghost ghost requested review from chenejac, litvinovg, delsborg and kaladay March 3, 2023 15:33
This was linked to issues Mar 3, 2023
Align Docker containers with changes introduced by decoupling VIVO build from installation #3822
Open
Docker containers usage: Server refused connection at: http://localhost:8983/solr/vivocore from VIVO container #3786
Open
chenejac
chenejac previously approved these changes Mar 6, 2023
View reviewed changes
Copy link
Contributor

@chenejac chenejac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wwelling please check my comments here, I suggest to review this PR instead of previous one (#3839), and of course we need to review Vitro PR as well (vivo-project/Vitro#370)

Dockerfile Show resolved Hide resolved
installer/webapp/src/main/webResources/WEB-INF/classes/log4j.properties Outdated Show resolved Hide resolved
start.sh Outdated Show resolved Hide resolved
@ghost ghost requested a review from chenejac March 6, 2023 14:24
@ghost
Copy link
Author

ghost commented Mar 6, 2023 •
edited by ghost
Loading

Dragan Ivanovic
3 days ago
Only bin, rdf and config files are copied into VIVO_HOME, right? I suppose some changes might happened into config and rdf in customized VIVO instances. I see the next scenarios:

  1. An institution is installing VIVO for the first time, there is only empty VIVO_HOME directory.
  2. An institution is upgrading VIVO, but didn't customized VIVO_HOME, meaning didn't change any single file in rdf and config.
  3. An institution is upgrading VIVO to some future VIVO which is not changing any file which should be copied to config or rdf subdirectories of VIVO_HOME, but institution customized its previous VIVO version by changing something in VIVO_HOME/config or VIVO_HOME/rdf.
  4. An institution is upgrading VIVO to some future VIVO which is changing some files which should be copied to config or rdf subdirectories of VIVO_HOME (introducing new property in default.runtime.properties, adding new n3 file in rdf, etc.), and institution also customized its previous VIVO version by changing something in VIVO_HOME/config or VIVO_HOME/rdf.

I suppose the first two scenarios are not a problem.
@William Welling
is manual creation of digest only solution for 3rd scenario (in the case when docker is not used), or it is also working for 4th scenario? Do you see any other scenario? We can add instructions for upgrading VIVO somewhere in wiki documentation. If it is just one command, I hope it wouldn't be a problem.

@ghost
Copy link
Author

ghost commented Mar 9, 2023 •
edited by ghost
Loading

1. An institution is installing VIVO for the first time, there is only empty VIVO_HOME directory.

 There is always a VIVO home directory now and not defined at build time but rather runtime. Previously, the maven process could have created the home directory if not exist.

2. An institution is upgrading VIVO, but didn't customized VIVO_HOME, meaning didn't change any single file in rdf and config.

 Upgrade will handle the rest now knowing there is a digest provided of the VIVO home directory.

3. An institution is upgrading VIVO to some future VIVO which is not changing any file which should be copied to config or rdf subdirectories of VIVO_HOME, but institution customized its previous VIVO version by changing something in VIVO_HOME/config or VIVO_HOME/rdf.

 Are there any home bin, config or rdf file changes on upgrade?

 Has the instance of VIVO been tampered with? i.e. has the system administrator, developers, or other personnel that have access to the terminal changed them? We have a known use case in which they are mutated but versioned in a fork. If implementer continues to build from source the VIVO application, they continue to do so but have to provide there VIVO home digest on restart or it may be in an uncertain state. Is a useful thing to know when restarting to avoid having graph dumped into your production triplestore.

4. An institution is upgrading VIVO to some future VIVO which is changing some files which should be copied to config or rdf subdirectories of VIVO_HOME (introducing new property in default.runtime.properties, adding new n3 file in rdf, etc.), and institution also customized its previous VIVO version by changing something in VIVO_HOME/config or VIVO_HOME/rdf.

 The customizations described here are most likely made in a repository fork and applied before build. Which means everything would work as expected.

@ghost ghost mentioned this pull request Apr 22, 2023
Closed
@chenejac chenejac marked this pull request as draft June 5, 2024 06:39
@chenejac chenejac added this to the v1.16 milestone Jun 5, 2024
@wwelling wwelling marked this pull request as ready for review August 22, 2024 18:42
@wwelling
Copy link
Contributor

Merge conflicts with #3940.

@wwelling wwelling closed this Sep 6, 2024
@wwelling wwelling deleted the VIVO-3786-3822-docker-updates branch September 6, 2024 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@litvinovg litvinovg Awaiting requested review from litvinovg

@delsborg delsborg Awaiting requested review from delsborg

@kaladay kaladay Awaiting requested review from kaladay

@chenejac chenejac Awaiting requested review from chenejac

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v1.16
2 participants
@wwelling @chenejac